Audience
Update an audience
Updates an existing audience with new information.
PATCH
/
audiences
Update an audience
curl --request PATCH \
--url https://your_a2_service/audiences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"alt_id": {},
"created_at": "2023-11-07T05:31:56Z",
"id_type": "account_id",
"properties": {},
"updated_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://your_a2_service/audiences"
payload = {
"id": "<string>",
"alt_id": {},
"created_at": "2023-11-07T05:31:56Z",
"id_type": "account_id",
"properties": {},
"updated_at": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
alt_id: {},
created_at: '2023-11-07T05:31:56Z',
id_type: 'account_id',
properties: {},
updated_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://your_a2_service/audiences', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your_a2_service/audiences",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'alt_id' => [
],
'created_at' => '2023-11-07T05:31:56Z',
'id_type' => 'account_id',
'properties' => [
],
'updated_at' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your_a2_service/audiences"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"alt_id\": {},\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"id_type\": \"account_id\",\n \"properties\": {},\n \"updated_at\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://your_a2_service/audiences")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"alt_id\": {},\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"id_type\": \"account_id\",\n \"properties\": {},\n \"updated_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your_a2_service/audiences")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"alt_id\": {},\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"id_type\": \"account_id\",\n \"properties\": {},\n \"updated_at\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"alt_id": {},
"created_at": "2023-11-07T05:31:56Z",
"id_type": "account_id",
"properties": {},
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
Represents a audience entity.
Alternate identifier for the audience
The date and time the entity was created.
The type of the identifier
Properties for the audience
The key is AudienceAttribute.code, and the value can be a list of AudienceAttributeValue.value
Show child attributes
Show child attributes
The date and time the entity was last updated.
Response
Successful Response
Represents a audience entity.
Alternate identifier for the audience
The date and time the entity was created.
The type of the identifier
Properties for the audience
The key is AudienceAttribute.code, and the value can be a list of AudienceAttributeValue.value
Show child attributes
Show child attributes
The date and time the entity was last updated.
Was this page helpful?
⌘I
Update an audience
curl --request PATCH \
--url https://your_a2_service/audiences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"alt_id": {},
"created_at": "2023-11-07T05:31:56Z",
"id_type": "account_id",
"properties": {},
"updated_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://your_a2_service/audiences"
payload = {
"id": "<string>",
"alt_id": {},
"created_at": "2023-11-07T05:31:56Z",
"id_type": "account_id",
"properties": {},
"updated_at": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
alt_id: {},
created_at: '2023-11-07T05:31:56Z',
id_type: 'account_id',
properties: {},
updated_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://your_a2_service/audiences', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your_a2_service/audiences",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'alt_id' => [
],
'created_at' => '2023-11-07T05:31:56Z',
'id_type' => 'account_id',
'properties' => [
],
'updated_at' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your_a2_service/audiences"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"alt_id\": {},\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"id_type\": \"account_id\",\n \"properties\": {},\n \"updated_at\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://your_a2_service/audiences")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"alt_id\": {},\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"id_type\": \"account_id\",\n \"properties\": {},\n \"updated_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your_a2_service/audiences")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"alt_id\": {},\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"id_type\": \"account_id\",\n \"properties\": {},\n \"updated_at\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"alt_id": {},
"created_at": "2023-11-07T05:31:56Z",
"id_type": "account_id",
"properties": {},
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}